REST API on Postman

The EMS xAPI Postman collections supports various authentication schemes, including Bearer Tokens, making it easier to test secured endpoints and manage session-level credentials like UserToken.

Follow the steps below to start using the EMS REST API on Postman:

  1. Visit the SSNC-Eze-EMS-xAPI path. The pre-configured Postman setup for EMS xAPI (REST) is launched.

  2. Select the EMS xAPI environment from the top-right dropdown list, shown below.

    Postman UI > Environment selection

  3. Navigate to the Authentication API using the left index, authentication > connect API > GET.

    Postman UI > Connect API (REST)

  4. Click Params tab.

    1. Enter your UserName, Domain, Password, and Locale details. Contact your SS&C Eze client service representative if you need any assistance.

      2. Note: Your account will be temporarily locked for 3 minutes if you attempt to log in three (3) times within 60 seconds, regardless of whether the attempts are successful or unsuccessful.

  5. Click Send. The status is displayed in the Responses pane.

    If your login is successful, a UserToken is generated. You will need this token for subsequent API calls.

  1. Bearer Token: You can also set the user token for your session by including it as a bearer token. Follow these steps:

    1. Select an API (e.g., connect).

    2. Click the Authorization tab.

    3. From the Auth Type dropdown list, select Bearer Token.

    4. In the Token field, enter the generated user token, as shown below.

      Once set, you do not need to enter the user token for each API call.

      Postman UI > Authorization > Bearer Token

Note: Swagger does not support the Subscribe APIs (e.g., SubscribeOrderInfoRequest).

Managed Cloud Platform (MCP)

You can use Postman with the Managed Cloud Platform (MCP) to generate a MCP server based on your selected API(s).

To generate a MCP server:

  1. Navigate to the online MCP Generator: https://www.postman.com/explore/mcp-generator.

  2. Click the Search for APIs (required) field at the center of the screen. The search window appears.

    Note: You need to be logged in to use the search feature.

  3. Enter EMS xAPI REST and select SS&C Eze EMS xAPI environment from the search results, shown below.

    Postman > MCP > SS&C Eze EMS xAPI environment

  4. In the left index, select the desired APIs. Use the right pane to enable the checkboxes for those APIs.

  5. Click Add Requests to add the selected APIs to the generator list.

  6. Click Generate to create the downloadable MCP ZIP file.

  7. Download the generated ZIP file.

    1. Unzip the file.

    2. Open the README.md file in the unzipped folder.

    3. Follow the instructions in the README.md for the next steps.